Opened a PR in synthtool to update conf.py file template googleapis/synthtool#629

@plamut The PR of synthtool googleapis/synthtool#629 has been merged so i will remove the doc/conf.py change from here, but i don't have an idea about change in synth.py file.

@HemangChothani I presume we still need to add the "inherited-members": True option to the docs config, because the synth template contains just the "members": True option? Re-generating the files with synthtool erases that latter part, thus we need to add it manually (through a replacement configured in synth.py)

Mentioning this, because running the synthtool produces the following change (among others):

diff --git docs/conf.py docs/conf.py
index 30dcac5..91b39ac 100644
--- docs/conf.py
+++ docs/conf.py
@@ -43,7 +43,7 @@ extensions = [
 
 # autodoc/autosummary flags
 autoclass_content = "both"
-autodoc_default_options = {"members": True, "inherited-members": True}
+autodoc_default_options = {"members": True}
 autosummary_generate = True

Or do you think we could actually make that change in the docs/conf.py template itself? (don't know if that's suitable for all Python client libs, though)

autodoc_default_options = {"members": True, "inherited-members": True}

@plamut
In synth.py file can we do that? I am not sure right now as i am struggling with synth config to local machine.

s.replace(
"docs/conf.py",
{"members": True},
{"members": True, "inherited-members": True}
)

I am not sure that it will work for all clients or not , i will test it.

@HemangChothani Yes, each library can add custom modifications to the generated files in its synth.py.

The snippet above is the right direction, just mind that the second argument is treated as a regular expression, thus regex special characters need to be escaped.

If you have trouble setting up synth locally, I can post a patch here myself to save time, as I already happen to have everything working locally.

@plamut Thank you for the guidance and support, i am able to run locally an test it and push the code, could you please verify it?